Skip to content

docs: create reports archive directory#2167

Merged
MonaaEid merged 3 commits into
hiero-ledger:mainfrom
shady-2004:docs/add-reports-archive
Apr 21, 2026
Merged

docs: create reports archive directory#2167
MonaaEid merged 3 commits into
hiero-ledger:mainfrom
shady-2004:docs/add-reports-archive

Conversation

@shady-2004

@shady-2004 shady-2004 commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

Description:
This PR adds a dedicated directory for publicly available report archives to satisfy project compliance and transparency requirements.

  • Create the docs/reports directory
  • Add a README.md file explaining the purpose of the archive for later searching

Related issue(s):

Fixes #2144

Notes for reviewer:
This is a documentation-only change to satisfy the project's requirement for a publicly available report archive. No code logic or SDK functionality was modified.

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@shady-2004
docs: create reports archive directory
c693849 
Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
Copilot AI review requested due to automatic review settings April 17, 2026 11:53
@shady-2004
shady-2004 requested review from a team as code owners April 17, 2026 11:53
@coderabbitai

coderabbitai Bot commented Apr 17, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

A new docs/reports/README.md file is created to establish a publicly available archive for reports and responses intended for future searchability and reference purposes.

Changes

Cohort / File(s) Summary
Documentation
docs/reports/README.md		 New README file explaining the purpose of the reports folder as a publicly available archive for reports and responses.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: creating a reports archive directory in the documentation folder.
Description check ✅ Passed The description is directly related to the changeset, explaining the purpose of adding a docs/reports directory with a README.md for a publicly available report archive.
Linked Issues check ✅ Passed The pull request meets all coding requirements from issue #2144: creates docs/reports directory and adds README.md explaining the archive's purpose for searchable reports.
Out of Scope Changes check ✅ Passed All changes are in scope—only a docs/reports directory and README.md file were added to satisfy issue #2144 requirements, with no unrelated modifications.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codacy-production

codacy-production Bot commented Apr 17, 2026 •
edited
Loading

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

Copilot AI reviewed Apr 17, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new docs/reports documentation directory intended to serve as a public archive for reports/responses (per compliance/transparency requirements) and includes a short README describing its purpose.

Changes:

  • Created docs/reports/ as the dedicated reports archive location.
  • Added docs/reports/README.md describing the archive’s purpose.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/reports/README.md
Comment thread docs/reports/README.md
@exploreriii exploreriii added step: 2nd second stage of the review approval process reviewer: write requires a review with write permissions labels Apr 17, 2026
@shady-2004 shady-2004 mentioned this pull request Apr 17, 2026
Closed
10 tasks
@manishdait

manishdait commented Apr 20, 2026

Copy link
Copy Markdown
Contributor

@shady-2004, Please update the branch

@github-actions github-actions Bot added Good First Issue Issues which are ideal for a first time or new project contributor. scope: docs involves documentation labels Apr 20, 2026
coderabbitai[bot]
coderabbitai Bot reviewed Apr 20, 2026
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: c8c0d02c-e465-46ff-8824-0d563bc790bb

📥 Commits

Reviewing files that changed from the base of the PR and between 4cf8bee and 796095a.

📒 Files selected for processing (1)
  • docs/reports/README.md

Comment thread docs/reports/README.md
aceppaluni
aceppaluni approved these changes Apr 20, 2026
View reviewed changes

@aceppaluni aceppaluni left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shady-2004 Looks good, just be sure to update. Thank you!

@MonaaEid
MonaaEid merged commit 81e0f6f into hiero-ledger:main Apr 21, 2026
9 checks passed
@MonaaEid MonaaEid added this to the v0.2.6 milestone Apr 21, 2026
Abhijeet2409 pushed a commit to Abhijeet2409/hiero-sdk-python that referenced this pull request Apr 22, 2026
@shady-2004 @Abhijeet2409
docs: create reports archive directory (hiero-ledger#2167)
3080d6d 
Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
AntonioCeppellini pushed a commit to AntonioCeppellini/hiero-sdk-python that referenced this pull request Apr 22, 2026
@shady-2004 @AntonioCeppellini
docs: create reports archive directory (hiero-ledger#2167)
09f2ed3 
Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
parvninama pushed a commit to parvninama/hiero-sdk-python that referenced this pull request Apr 25, 2026
@shady-2004 @parvninama
docs: create reports archive directory (hiero-ledger#2167)
7969383 
Signed-off-by: shady-2004 <shadyshiko2004@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
Copilot code review Copilot Copilot left review comments
@manishdait manishdait manishdait approved these changes
@aceppaluni aceppaluni aceppaluni approved these changes
@exploreriii exploreriii exploreriii approved these changes
@Adityarya11 Adityarya11 Awaiting requested review from Adityarya11 Adityarya11 is a code owner automatically assigned from hiero-ledger/hiero-sdk-python-committers
@nadineloepfe nadineloepfe Awaiting requested review from nadineloepfe nadineloepfe is a code owner automatically assigned from hiero-ledger/hiero-sdk-python-maintainers

Assignees

No one assigned

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. reviewer: write requires a review with write permissions scope: docs involves documentation step: 2nd second stage of the review approval process

Projects

None yet

Milestone

v0.2.6

Development

Successfully merging this pull request may close these issues.

Create docs/reports

6 participants

@shady-2004 @manishdait @aceppaluni @exploreriii @MonaaEid